LoRaConfigOrBuilder

interface LoRaConfigOrBuilder : MessageOrBuilder

Inheritors

Functions

Link copied to clipboard
abstract fun getBandwidth(): Int

Bandwidth in MHz
Certain bandwidth numbers are 'special' and will be converted to the
appropriate floating point value: 31 -> 31.25MHz
uint32 bandwidth = 3;
Link copied to clipboard
abstract fun getChannelNum(): Int

This controls the actual hardware frequency the radio transmits on.
Most users should never need to be exposed to this field/concept.
A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region).
If ZERO then the rule is "use the old channel name hash based
algorithm to derive the channel number")
If using the hash algorithm the channel number will be: hash(channel_name) %
NUM_CHANNELS (Where num channels depends on the regulatory region).
uint32 channel_num = 11;
Link copied to clipboard
abstract fun getCodingRate(): Int

The denominator of the coding rate.
ie for 4/5, the value is 5. 4/8 the value is 8.
uint32 coding_rate = 5;
Link copied to clipboard
abstract fun getConfigOkToMqtt(): Boolean

Sets the ok_to_mqtt bit on outgoing packets
bool config_ok_to_mqtt = 105;
Link copied to clipboard
abstract fun getFrequencyOffset(): Float

This parameter is for advanced users with advanced test equipment, we do not recommend most users use it.
A frequency offset that is added to to the calculated band center frequency.
Used to correct for crystal calibration errors.
float frequency_offset = 6;
Link copied to clipboard
abstract fun getHopLimit(): Int

Maximum number of hops. This can't be greater than 7.
Default of 3
Attempting to set a value > 7 results in the default
uint32 hop_limit = 8;
Link copied to clipboard
abstract fun getIgnoreIncoming(index: Int): Int

For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
abstract fun getIgnoreIncomingCount(): Int

For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
repeated uint32 ignore_incoming = 103;
Link copied to clipboard

For testing it is useful sometimes to force a node to never listen to
particular other nodes (simulating radio out of range). All nodenums listed
in ignore_incoming will have packets they send dropped on receive (by router.cpp)
repeated uint32 ignore_incoming = 103;
Link copied to clipboard
abstract fun getIgnoreMqtt(): Boolean

If true, the device will not process any packets received via LoRa that passed via MQTT anywhere on the path towards it.
bool ignore_mqtt = 104;
Link copied to clipboard

Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard
abstract fun getModemPresetValue(): Int

Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH.
As a heuristic: If bandwidth is specified, do not use modem_config.
Because protobufs take ZERO space when the value is zero this works out nicely.
This value is replaced by bandwidth/spread_factor/coding_rate.
If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.
.meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 2;
Link copied to clipboard

If true, duty cycle limits will be exceeded and thus you're possibly not following
the local regulations if you're not a HAM.
Has no effect if the duty cycle of the used region is 100%.
bool override_duty_cycle = 12;
Link copied to clipboard
abstract fun getOverrideFrequency(): Float

This parameter is for advanced users and licensed HAM radio operators.
Ignore Channel Calculation and use this frequency instead. The frequency_offset
will still be applied. This will allow you to use out-of-band frequencies.
Please respect your local laws and regulations. If you are a HAM, make sure you
enable HAM mode and turn off encryption.
float override_frequency = 14;
Link copied to clipboard
abstract fun getPaFanDisabled(): Boolean

If true, disable the build-in PA FAN using pin define in RF95_FAN_EN.
bool pa_fan_disabled = 15;
Link copied to clipboard

The region code for the radio (US, CN, EU433, etc...)
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
abstract fun getRegionValue(): Int

The region code for the radio (US, CN, EU433, etc...)
.meshtastic.Config.LoRaConfig.RegionCode region = 7;
Link copied to clipboard
abstract fun getSpreadFactor(): Int

A number from 7 to 12.
Indicates number of chirps per symbol as 1<<spread_factor.
uint32 spread_factor = 4;
Link copied to clipboard

If true, sets RX boosted gain mode on SX126X based radios
bool sx126x_rx_boosted_gain = 13;
Link copied to clipboard
abstract fun getTxEnabled(): Boolean

Disable TX from the LoRa radio. Useful for hot-swapping antennas and other tests.
Defaults to false
bool tx_enabled = 9;
Link copied to clipboard
abstract fun getTxPower(): Int

If zero, then use default max legal continuous power (ie. something that won't
burn out the radio hardware)
In most cases you should use zero here.
Units are in dBm.
int32 tx_power = 10;
Link copied to clipboard
abstract fun getUsePreset(): Boolean

When enabled, the `modem_preset` fields will be adhered to, else the `bandwidth`/`spread_factor`/`coding_rate`
will be taked from their respective manually defined fields
bool use_preset = 1;